<html xmlns:fo="http://www.w3.org/1999/XSL/Format"><head><title>mx.fmxis.FMXISJog Class</title><link rel="stylesheet" type="text/css" href="../../../docs.css"></link></head><body><h1>FMXISJog Class</h1><p><b>Class </b>mx.fmxis.FMXISJog</p><p><b>Inheritance </b>
			
			&gt;
			
		<a href="../FMXISBase/Class.htm">FMXISBase</a>
			
			&gt;
			
		<a href="Class.htm">FMXISJog</a></p><div class="description"><p>This class implements a simple jog.  Developers can set the increment, number of positions
in one cycle, integer vs. discrete, and whether the jog is adjusted by clicking and dragging,
or merely moving in a circular motion (<code>dragOrOver</code>).</p>
<br /><br />
Developers can change the appearance by modifying:
<li><code>defJogBkgnd</code> - background</li>
<li><code>defJogIndicator</code> - indicator clip</li>
<li><code>defJogIncr</code> - Increment button (increments by 1 unit)</li>
<li><code>defJogDecr</code> - Decrement button (decrements by 1 unit)</li>
<br /><br />
<p>The class also has one property that developers can set in the component property panel,
<code>indLinkID</code>, that replaces the default indicator graphic with a movie clip from
the Library specified by the linkage ID supplied.  The movie clip must have its center at
the center of rotation, so if the developer simply wants to change the indicator (notch), then the
indicator should be placed in the topmost (pointing up) position at the edge of the background.  When
a linkage ID is given, the component scales the background graphic to the maximum dimension of the indicator
movie clip, so the hit area (determined by the background) is correct.  Usually, the developer will
want to turn off the background graphic (using the property in the component property panel).</p>
<p>The class has one event, by default called "onValChg" (but this can
be changed in the property inspector, or by changing the <code>vChg</code> property), and
the value is the increment that
the jog was moved.  The <code>drawTicks</code> property, if true, tells the component
to draw <code>numTicks</code> ticks.</p>
<br /><br />
<p>The position of the jog indicator can be set using the <code>val</code> property.</p>
<br /><br />
<p>This class inherits from <code>FMXISBase</code> to get listener capabilities.</p></div><table border="1" cellpadding="2" cellspacing="0"><tr><th colspan="2" class="ObjectsSummaryHeading">Property Summary</th></tr><tr><td valign="top" width="1%"><span class="Attributes">&nbsp;</span><span class="type">String</span>&nbsp;</td><td valign="top"><div class="functionNameAndParams">&nbsp;<a href="#className">className</a></div><div class="functionSummaryLine"></div></td></tr><tr><td valign="top" width="1%"><span class="Attributes">&nbsp;</span><span class="type"></span>&nbsp;</td><td valign="top"><div class="functionNameAndParams">&nbsp;<a href="#clickSnd">clickSnd</a></div><div class="functionSummaryLine"></div></td></tr><tr><td valign="top" width="1%"><span class="Attributes">&nbsp;</span><span class="type"></span>&nbsp;</td><td valign="top"><div class="functionNameAndParams">&nbsp;<a href="#discreteSteps">discreteSteps</a></div><div class="functionSummaryLine"></div></td></tr><tr><td valign="top" width="1%"><span class="Attributes">&nbsp;static&nbsp;</span><span class="type"></span>&nbsp;</td><td valign="top"><div class="functionNameAndParams">&nbsp;<a href="#JogEvent">JogEvent</a></div><div class="functionSummaryLine"></div></td></tr><tr><td valign="top" width="1%"><span class="Attributes">&nbsp;</span><span class="type"></span>&nbsp;</td><td valign="top"><div class="functionNameAndParams">&nbsp;<a href="#numTicks">numTicks</a></div><div class="functionSummaryLine"></div></td></tr><tr><td valign="top" width="1%"><span class="Attributes">&nbsp;</span><span class="type"></span>&nbsp;</td><td valign="top"><div class="functionNameAndParams">&nbsp;<a href="#showButs">showButs</a></div><div class="functionSummaryLine"></div></td></tr><tr><td valign="top" width="1%"><span class="Attributes">&nbsp;</span><span class="type"></span>&nbsp;</td><td valign="top"><div class="functionNameAndParams">&nbsp;<a href="#showTicks">showTicks</a></div><div class="functionSummaryLine"></div></td></tr><tr><td valign="top" width="1%"><span class="Attributes">&nbsp;</span><span class="type">Boolean</span>&nbsp;</td><td valign="top"><div class="functionNameAndParams">&nbsp;<a href="#snap2Int">snap2Int</a></div><div class="functionSummaryLine"></div></td></tr><tr><td valign="top" width="1%"><span class="Attributes">&nbsp;static&nbsp;</span><span class="type">String</span>&nbsp;</td><td valign="top"><div class="functionNameAndParams">&nbsp;<a href="#symbolName">symbolName</a></div><div class="functionSummaryLine"></div></td></tr><tr><td valign="top" width="1%"><span class="Attributes">&nbsp;static&nbsp;</span><span class="type">Object</span>&nbsp;</td><td valign="top"><div class="functionNameAndParams">&nbsp;<a href="#symbolOwner">symbolOwner</a></div><div class="functionSummaryLine"></div></td></tr><tr><td valign="top" width="1%"><span class="Attributes">&nbsp;</span><span class="type">Number</span>&nbsp;</td><td valign="top"><div class="functionNameAndParams">&nbsp;<a href="#units">units</a></div><div class="functionSummaryLine"></div></td></tr><tr><td valign="top" width="1%"><span class="Attributes">&nbsp;</span><span class="type">Number</span>&nbsp;</td><td valign="top"><div class="functionNameAndParams">&nbsp;<a href="#val">val</a></div><div class="functionSummaryLine"></div></td></tr><tr><td valign="top" width="1%"><span class="Attributes">&nbsp;</span><span class="type">String</span>&nbsp;</td><td valign="top"><div class="functionNameAndParams">&nbsp;<a href="#vChg">vChg</a></div><div class="functionSummaryLine"></div></td></tr></table><table border="1" cellpadding="2" cellspacing="0" class="inheritedObjects"><tr><th class="InheritedHeading">Properties inherited from mx.fmxis.FMXISBase</th></tr><tr><td><div class="inheritedMemberList"><a href="../FMXISBase/Class.htm#addEventListener">addEventListener</a>, <a href="../FMXISBase/Class.htm#clipParameters">clipParameters</a>, <a href="../FMXISBase/Class.htm#removeEventListener">removeEventListener</a></div></td></tr></table><table border="1" cellpadding="2" cellspacing="0"><tr><th colspan="2" class="ObjectsSummaryHeading">Method Summary</th></tr><tr><td valign="top" width="1%"><span class="Attributes">&nbsp;</span><span class="type">Void</span>&nbsp;</td><td valign="top"><div class="functionNameAndParams">&nbsp;<a href="#decrJog">decrJog</a>()</div><div class="functionSummaryLine">Decrease the jog by 1 unit.</div></td></tr><tr><td valign="top" width="1%"><span class="Attributes">&nbsp;</span><span class="type">Void</span>&nbsp;</td><td valign="top"><div class="functionNameAndParams">&nbsp;<a href="#execEvent">execEvent</a>(evName:String, evVal, q:Boolean)</div><div class="functionSummaryLine">Given an event string and value that matches what this component would generate, perform the action.</div></td></tr><tr><td valign="top" width="1%"><span class="Attributes">&nbsp;</span><span class="type">Void</span>&nbsp;</td><td valign="top"><div class="functionNameAndParams">&nbsp;<a href="#incrJog">incrJog</a>()</div><div class="functionSummaryLine">Increase the jog by 1 unit.</div></td></tr><tr><td valign="top" width="1%"><span class="Attributes">&nbsp;</span><span class="type"></span>&nbsp;</td><td valign="top"><div class="functionNameAndParams">&nbsp;<a href="#incrVal">incrVal</a>(incr, q)</div><div class="functionSummaryLine">Increments the jog by incr units (positive or negative).</div></td></tr></table><table border="1" cellpadding="2" cellspacing="0" class="inheritedObjects"><tr><th class="InheritedHeading">Methods inherited from mx.fmxis.FMXISBase</th></tr><tr><td><div class="inheritedMemberList"><a href="../FMXISBase/Class.htm#addListener">addListener</a>, <a href="../FMXISBase/Class.htm#init">init</a>, <a href="../FMXISBase/Class.htm#removeListener">removeListener</a></div></td></tr></table><table border="1" cellpadding="2" cellspacing="0"><tr><th colspan="2" class="ObjectsSummaryHeading">Event Summary</th></tr><tr><td valign="top" width="1%"><span class="Attributes">&nbsp;</span><span class="type"></span>&nbsp;</td><td valign="top"><div class="functionNameAndParams">&nbsp;<a href="#onValChg">onValChg</a></div><div class="functionSummaryLine">Event generated when jog knob value has changed.</div></td></tr></table><table border="1" cellpadding="2" cellspacing="0"><tr><th class="ObjectsDetailHeading">Property Detail</th></tr></table><div class="DetailRow"><a name="className"></a><div class="DetailObjectTitle">className</div><div class="DetailObjectDeclaration"> var className:String;</div><div class="DetailDescription"></div></div><div class="DetailRow"><a name="clickSnd"></a><div class="DetailObjectTitle">clickSnd</div><div class="DetailObjectDeclaration">public function get/set clickSnd()</div><div class="DetailDescription"></div></div><div class="DetailRow"><a name="discreteSteps"></a><div class="DetailObjectTitle">discreteSteps</div><div class="DetailObjectDeclaration">public function get/set discreteSteps()</div><div class="DetailDescription"></div></div><div class="DetailRow"><a name="JogEvent"></a><div class="DetailObjectTitle">JogEvent</div><div class="DetailObjectDeclaration"> static var JogEvent;</div><div class="DetailDescription"></div></div><div class="DetailRow"><a name="numTicks"></a><div class="DetailObjectTitle">numTicks</div><div class="DetailObjectDeclaration">public function get/set numTicks()</div><div class="DetailDescription"></div></div><div class="DetailRow"><a name="showButs"></a><div class="DetailObjectTitle">showButs</div><div class="DetailObjectDeclaration">public function get/set showButs()</div><div class="DetailDescription"></div></div><div class="DetailRow"><a name="showTicks"></a><div class="DetailObjectTitle">showTicks</div><div class="DetailObjectDeclaration">public function get/set showTicks()</div><div class="DetailDescription"></div></div><div class="DetailRow"><a name="snap2Int"></a><div class="DetailObjectTitle">snap2Int</div><div class="DetailObjectDeclaration">public var snap2Int:Boolean;</div><div class="DetailDescription"></div></div><div class="DetailRow"><a name="symbolName"></a><div class="DetailObjectTitle">symbolName</div><div class="DetailObjectDeclaration"> static var symbolName:String;</div><div class="DetailDescription"></div></div><div class="DetailRow"><a name="symbolOwner"></a><div class="DetailObjectTitle">symbolOwner</div><div class="DetailObjectDeclaration"> static var symbolOwner:Object;</div><div class="DetailDescription"></div></div><div class="DetailRow"><a name="units"></a><div class="DetailObjectTitle">units</div><div class="DetailObjectDeclaration">public function get/set units():Number</div><div class="DetailDescription"></div></div><div class="DetailRow"><a name="val"></a><div class="DetailObjectTitle">val</div><div class="DetailObjectDeclaration">public function get/set val():Number</div><div class="DetailDescription"></div></div><div class="DetailRow"><a name="vChg"></a><div class="DetailObjectTitle">vChg</div><div class="DetailObjectDeclaration">public var vChg:String;</div><div class="DetailDescription"></div></div><table border="1" cellpadding="2" cellspacing="0"><tr><th class="ObjectsDetailHeading">Method Detail</th></tr></table><div class="DetailRow"><a name="decrJog"></a><div class="DetailObjectTitle">decrJog</div><div class="DetailObjectDeclaration">public function  decrJog():Void</div><div class="DetailDescription">Decrease the jog by 1 unit.</div></div><div class="DetailRow"><a name="execEvent"></a><div class="DetailObjectTitle">execEvent</div><div class="DetailObjectDeclaration">public function  execEvent(evName:String, evVal, q:Boolean):Void</div><div class="DetailDescription">Given an event string and value that matches what this component would generate, perform the action.
For the jog component, the event is onValChg and the value is the increment.</div><div class="DetailParamsTitle">Parameters:</div><div class="DetailParamsLine"><code>evName</code> - Event name (string) must match the event this component generates</div><div class="DetailParamsLine"><code>evVal</code> - (optional) value accompanying the event (if the event has an accompanying value)</div><div class="DetailParamsLine"><code>quiet</code> - (optional) set this to true if component should perform the action but not generate an event (this should be false or undefined, unless you know what you are doing)</div><div class="DetailsExampleTitle">Example</div><div class="DetailsExampleLine">myJog.execEvent("onValChg", 1); // increments jog by 1 unit</div></div><div class="DetailRow"><a name="incrJog"></a><div class="DetailObjectTitle">incrJog</div><div class="DetailObjectDeclaration">public function  incrJog():Void</div><div class="DetailDescription">Increase the jog by 1 unit.</div></div><div class="DetailRow"><a name="incrVal"></a><div class="DetailObjectTitle">incrVal</div><div class="DetailObjectDeclaration">public function  incrVal(incr, q)</div><div class="DetailDescription">Increments the jog by incr units (positive or negative).  This can be used to simulate turning the jog.</div><div class="DetailParamsTitle">Parameters:</div><div class="DetailParamsLine"><code>incr</code> - Numeric increment to change the jog.</div><div class="DetailParamsLine"><code>quietly</code> - (optional) Set this to true to make the change without generating an event.</div><div class="DetailsExampleTitle">Example</div><div class="DetailsExampleLine">myJog.incrVal(2.5);</div></div><table border="1" cellpadding="2" cellspacing="0"><tr><th class="ObjectsDetailHeading">Event Detail</th></tr></table><div class="DetailRow"><a name="onValChg"></a><div class="DetailObjectTitle">onValChg</div><div class="DetailObjectDeclaration"> function  onValChg(<i>eventObj</i>)</div><div class="DetailDescription">Event generated when jog knob value has changed.</div></div><br /><br /><hr /><span style='font-size: x-small; font-family: Verdana, Arial'>Documentation generated by <a href='http://wwww.blinex.com/products/bldoc' target='_blank' alt='BLDoc Link'>BLDoc Community Edition</a> from <a href='http://www.blinex.com' target='_blank' alt='B-Line Express Website'>B-Line Express</a>.</body></html>